home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / comm1 / calllggr.lha / call_log1 / Call_Logger_READ_ME! < prev   
Text File  |  1996-05-08  |  18KB  |  384 lines
  1. ===========================================================================
  2.         Call Logger, v3.32 READ_ME File By Dotoran of Frontiers BBS!
  3. ===========================================================================
  4.  
  5.     This is a "Last 10 Callers" type of program, but gives the Sysop a lot
  6. more flexibility in the customization of the finished output file. The out-
  7. put file is suitable for use as a Text File on your system, or for inclusion
  8. into your "sys.welcome" file.
  9.  
  10.     For those upgrading from v2.0, please search out the term CONVERT for
  11. information on installing the new version.
  12.  
  13.     If converting from v3.2(or higher), simply replace the Call_Logger file
  14. you're currently using with the newer one that came in this archive.
  15.  
  16. What you should have:
  17. ~~~~~~~~~~~~~~~~~~~~~
  18.     The following files should have been included with this archive. If any
  19. of the files is missing, DO NOT TRUST THIS ARCHIVE!
  20.  
  21.     Call_Log1                   - Directory.
  22.         Call_Logger             - Arexx Command File.
  23.         Call_Logger_READ_ME!    - This Text File.
  24.         Call_Logger_HISTORY!    - Lists Changes to Call_Logger.
  25.  
  26. What will Call_Logger do:
  27. ~~~~~~~~~~~~~~~~~~~~~~~~~
  28.     Call_Logger will create a text file listing past callers to your system,
  29. along with stats on what they did while online. Each line in the Call_Log
  30. follows the format given below:
  31.  
  32. 0  1  *Dotoran          96 [prudgtfm]  10:00a 10:25a  3  Ami  50   12   2
  33. |  |  |   |              |     |         |      |     |   |    |    |   |
  34. A  B  C   D              E     F         G      H     I   J    K    L   M
  35.  
  36. A: Port connection was made to.
  37. B: The ID number of the user who logged on.
  38. C: The NEW USER flag. If present, this is user's first call to your system.
  39. D: Handle of the user who logged on.
  40. E: Baud rate user connected with(divided by 100).
  41. F: Activity Flags:
  42.     P:ost, R:esponse, U:pload, D:ownload, G:ame, T:ext, F:eedback, M:ail
  43.     "Nothing!" will be printed if NONE of the above flags occurred.
  44. G: Sign-On time of the user.
  45. H: Log-Off time of the user.
  46. I: User's access group number.
  47. J: User's computer type(first three characters only).
  48. K: Total number of calls this user has made to your system.
  49. L: Total number of uploaded files this user has made to your system.
  50. M: Total number of posts AND responses this user has written.
  51.  
  52. How to install the Logger:
  53. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  54.     To install Call_Logger, v3.32, follow these steps:
  55.  
  56. 1: Copy the "Call_Log1" directory and it's files into a directory of your
  57.    choosing. It doesn't matter where you choose to store this directory, so
  58.    long as you keep all files INSIDE of this directory.
  59.  
  60. 2: In the "bbstext" file, on line 99 of the 3.05c version, locate
  61.    the following text: "@ Logoff complete\n1".
  62.  
  63. 3: Add the following to the END of that line, so that the finished line
  64.    looks like this:
  65.  
  66.    @ Logoff complete\n1{#0doors:Call_Log1/Call_Logger}
  67.                        ^
  68.                     Control-Q
  69.  
  70.    NOTE: If you chose to store the "Call_Log1/" directory in some other
  71.          location other than "doors:", change the above accordingly.
  72.  
  73. 4: Add the following line somewhere in your "sys.welcome" file:
  74.  
  75.            {*4texts:Call_Log}
  76.            ^
  77.         Control-Q
  78.  
  79. 5: If you want a wait to immediately follow the Call_Log, add this line
  80.    right after the above line in your "sys.welcome" file:
  81.  
  82.            \cfPress \c6ENTER \cfnow...\i1
  83.            `--------^---.----^--------'
  84.                         |
  85.                 CONTROL-Y characters
  86.  
  87.     That is all you HAVE to do to get the Logger functioning on your system,
  88. but you may want to customize the Logger to suit your needs better.
  89.  
  90. How to customize the Logger:
  91. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92.     To customize the Logger for a more personal touch, you may edit the 16
  93. variables located near the beginning of the "Call_Logger" file. To do this,
  94. load the "Call_Logger" file into your favorite text editor. Starting on line
  95. 10 are the sixteen Sysop definable variables that will be described fully
  96. below:
  97.  
  98. V1:     {Ignore Ports}      - Default is [LOG ALL PORTS]
  99. ~~~
  100.     This variable allows you to specify any ports you wish NOT to be logged.
  101.     To add ports to the variable, enclose them in double quote marks and
  102.     make sure to separate them with at least ONE space.
  103.  
  104.     EXAMPLES:   "0"     -   Do NOT log calls made from port # 0.
  105.                 "0 2"   -   Do NOT log calls made from ports 0 or 2.
  106.                 "X"     -   Log calls from ALL PORTS.
  107. ____________________________________________________________________________
  108.  
  109. V2:     {Ignore ID's}       - Default is [LOG ALL ID NUMBERS]
  110. ~~~
  111.     This variable allows you to specify any ID numbers you do NOT want
  112.     logged. To add ID numbers, follow the same rules as for "V1".
  113.  
  114.     EXAMPLES:   "1"     -   Do NOT log calls made by ID number 1.
  115.                 "1 2"   -   Do NOT log calls from ID numbers 1 or 2.
  116.                 "0"     -   Do NOT log calls made by "guests".
  117.                 "X"     -   Log calls from ALL ID NUMBERS.
  118.  
  119.     NOTE:   Guests are NEW users that do not supply a PASSWORD.
  120. ____________________________________________________________________________
  121.  
  122. V3:     {Ignore Accesses}   - Default is [LOG ALL ACCESS LEVELS]
  123. ~~~
  124.     This variable allows you to specify any Access Levels you do NOT want
  125.     logged. To add Access Levels, follow the "V1" rules.
  126.  
  127.     EXAMPLES:   "0"     -   Do NOT log calls made by Access Level 0 users.
  128.                 "30 31" -   Do NOT log level 30 or level 31 users.
  129.                 "X"     -   Log calls from ALL ACCESS LEVELS.
  130. ____________________________________________________________________________
  131.  
  132. V4:     {Max To Ever Log}   - Default is [LOG 10 CALLS: LAST 10 CALLERS]
  133. ~~~
  134.     This variable allows you to control the size of the Call_Log file. You
  135.     can set this variable to ANY value, but I suggest keeping it between
  136.     1 and 13. This number tells the Logger the total number of calls that
  137.     can ever be in the Call_Log at one time.
  138. ____________________________________________________________________________
  139.  
  140. V5:     {Save Call-Backs}   - Defaults to [DO NOT SAVE CALL BACKS]
  141. ~~~
  142.     This variable allows (or disallows) the Logger to log Call-Backs. A
  143.     call-back is when the same user calls your system twice in a row. This
  144.     variable can have two(2) values:
  145.  
  146.         V5 = 0  - ( Call Backs should NOT be logged; default)
  147.         V5 = 1  - ( Call Backs should ALWAYS be logged)
  148. ____________________________________________________________________________
  149.  
  150. V6:     {Log Sysops}        - Defaults to [LOG EVERY FIFTH SYSOP CALL]
  151. ~~~
  152.     This variable allows you to specify how often the Logger will log calls
  153.     made by the SysOp(only ID Number 1). The Logger keeps track of each time
  154.     the SysOp passes through the Logger and logs their call when the total
  155.     equals this value.
  156. ____________________________________________________________________________
  157.  
  158. V7:     {Activity BackDrop} - Defaults to [ 2  - ( [--------] ) ]
  159. ~~~
  160.     This variable defines what the Non-Use Activity Flags will look like.
  161.     The variable can have a value between one(1) and seven(7).
  162.  
  163.         V7 = 1 ( gives: [........] )       V7 = 2 ( gives: [--------] )
  164.         V7 = 3 ( gives: [prudgtfn] )       V7 = 4 ( gives: [********] )
  165.         V7 = 5 ( gives: [xxxxxxxx] )       V7 = 6 ( gives: [========] )
  166.         V7 = 7 ( Non-Use Activity Flags will use character in V8 )
  167.  
  168.     NOTE1: If using the new Quick Call_Log output, it is suggested that you
  169.            use a value of 1 or 2 for V7 for the best readability.
  170.  
  171.     NOTE2: If no activity was performed by the logged caller, the flag data
  172.            will be replaced with [Nothing!].
  173. ____________________________________________________________________________
  174.  
  175. V8:     {V7 Filler}         - Defaults to [THE   #   CHARACTER]
  176. ~~~
  177.     This variable is used in conjunction with the V7 variable. In fact, the
  178.     V8 variable is ONLY used when the V7 variable holds a 7.    V7 = 7
  179.     The character within the V8 variable is used as the Non-Use character
  180.     in the Activity Flags when V7 = 7.
  181.  
  182.     EXAMPLES:   V7 = 7   &   V8 = "#"  ( gives: [########] )
  183.                 V7 = 7   &   V8 = "^"  ( gives: [^^^^^^^^] )
  184. ____________________________________________________________________________
  185.  
  186. V9:     {Abortable Log}     - Defaults to [ALLOW LOG TO BE ABORTED]
  187. ~~~
  188.     This variable allows you to create a Call_Log that can be aborted by the
  189.     user when the /, SPACE, or CTRL-C key combinations are pressed, or to
  190.     create a Call_Log that can NOT be aborted with these sequences.
  191.  
  192.         V9 = 0  - ( Log can NOT be aborted by the user)
  193.         V9 = 1  - ( Log CAN be aborted by the user)
  194. ____________________________________________________________________________
  195.  
  196. V10:    {Output Type}       - Defaults to [QUICK CALL_LOG OUTPUT]
  197. ~~~~
  198.     You can now choose between two different looking Call_Logs.
  199.  
  200.         V10 = 0  - ( The elaborate BLUE Call_Log from v2.0)
  201.         V10 = 1  - ( The NEW Quick Grey Call_Log from v3.0)
  202. ____________________________________________________________________________
  203.  
  204. V11:    {Log Ordering}      - Defaults to [NEWEST CALLS FIRST IN LOG]
  205. ~~~~
  206.     You can now choose which order you wish the call data to come in.
  207.  
  208.         V11 = 0  - ( The NEWEST calls come first in the Log)
  209.         V12 = 1  - ( The OLDEST calls come first in the Log)
  210. ____________________________________________________________________________
  211.  
  212. V12:    {Quick Colors}      - Defaults to [ db   (Lt.Purple/Lt.Yellow)]
  213. ~~~~
  214.     This variable is only used with the NEW Quick Log( V10 = 1 ). The
  215.     contents of this variable tell the Logger which colors to make the call
  216.     entries in the Quick Log. The colors will cycle through. The default
  217.     value will create a Quick Log using Light Purple and Light Yellow for
  218.     the Log entries. The contents of this variable are the MCI color codes
  219.     needed, MINUS the \c
  220.  
  221.     EXAMPLES:   V12 = '9fc'     - ( Creates a RED / WHITE / BLUE Quick Log)
  222.                 V12 = '6e'      - ( Creates a CYAN / LIGHT CYAN Quick Log)
  223. ____________________________________________________________________________
  224.  
  225. V13:    {Notate Ignores}    - Defaults to [DO NOT NOTATE IGNORED CALLS]
  226. ~~~~
  227.     This variable allows you to notate that a call was made, but will not
  228.     list personal data if the call that passed through the Logger would
  229.     normally have been ignored, as set by the values in the V1, V2, V3, V5,
  230.     and V6 variables.
  231.  
  232.         V13 = 0  - ( Do NOT notate ignored calls)
  233.         V13 = 1  - ( NOTATE any calls that would normally be ignored)
  234. ____________________________________________________________________________
  235.  
  236. V14:    {Border Color}      - Defaults to [Use BRIGHT BLUE for Border]
  237. ~~~~
  238.     This variable is NEW to Call_Logger v3.3! I discovered that the Dark
  239.     Grey color of the Border used in the Quick Log format showed as BLACK
  240.     on 8-color terminal screens, so I needed to change the color, but then
  241.     I thought the SysOps might like the ability to change it themselves.
  242.  
  243.         V14 = "1"  - ( Use \cc (dark red) for border color )
  244.         V14 = "f"  - ( Use \cf (bright white for border color )
  245. ____________________________________________________________________________
  246.  
  247. V15:    {Clear Screen}      - Defaults to [CLEAR SCREEN BEFORE DISPLAYING]
  248. ~~~~
  249.     This variable is NEW to Call_Logger v3.3! This variable allows you to
  250.     specify if you wish the screen to be CLEARED before the Call_Log is
  251.     displayed on the screen. By NOT clearing the screen, you get kind of a
  252.     neat "scrolling" effect to the log that some SysOps might enjoy.
  253.  
  254.         V15 = 1    - ( Clear the screen before displaying log )
  255.         V15 = 0    - ( Do NOT clear the screen before displaying log )
  256. ____________________________________________________________________________
  257.  
  258. D1:     {Call_Log Path}     - Defaults to [  TEXTS:  ]
  259. ~~~
  260.     This variable tells the Logger where to store the outputted Call_Log
  261.     file. Normally, this would be the Texts: directory, but in the event
  262.     you wish to store it elsewhere, you will need to change this variable.
  263.     The contents of this variable must ALWAYS end with either a colon( : ),
  264.     or a slash( / ).
  265.  
  266.     NOTE1: If you CHANGE this variable, you will also have to edit the line
  267.            you added to the "sys.welcome" file to reflect this change.
  268.  
  269.     NOTE2: This is the reason the directory is called "Call_Log1", just in
  270.            case you wish to store it in the same directory you placed the
  271.            "Call_Log1/" directory.
  272. ____________________________________________________________________________
  273.  
  274. Editing Variables PostLogged:
  275. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  276.     The Logger has been tested thoroughly as far as changing the variables
  277. on the fly. Although changing certain variables may have an obverse affect
  278. on how the Log looks, eventually the Log will clean itself up:
  279.  
  280.    EXAMPLE1: Your running the Elaborate BLUE Log and decide you want to
  281.              change to the NEW Quick Grey Log. Simply changing the V10
  282.              variable is all that is needed. Both Logs line up, but you
  283.              will notice that some of the older entries in the Log are of
  284.              the Elaborate type. After a couple of calls, these OLD Log
  285.              entries will be replaced by newer Quick Log entries.
  286.  
  287.    EXAMPLE2: Your using dashes for the Log Activity and decide to go with
  288.              the lowercase letters. Simply change the V7 variable. Older
  289.              entries will still have the dashes, while newer entries will
  290.              use the lowercase letters. Just as above, as soon as a couple
  291.              more calls are logged, the older dashed entries will vanish.
  292.  
  293.    EXAMPLE3: You decide to reverse the ordering of the Log from Oldest 1st
  294.              to Newest 1st. You simply change the V11 variable. You will
  295.              notice that the SignOn/SignOff times don't seem to match up.
  296.              Again, soon they will, once a couple more calls are logged.
  297. ____________________________________________________________________________
  298.  
  299. Using the Logger:
  300. ~~~~~~~~~~~~~~~~~
  301.     To use the log, simply log onto your bbs. If you've added the "Call_Log"
  302. file somewhere in your logon(like in "sys.welcome"), then you will be shown
  303. the log. Once you've logged on, log yourself off. The Logger will log your
  304. call, unless you've specified variables that will not capture your call.
  305. Check variables V1, V2, V3, V5, and/or V6 if it's not logging YOUR calls.
  306.  
  307.     You will know for sure that the Logger logs your call if it prints the
  308. message: "Logging your call..." directly below the "@ Logoff complete"
  309. message. If the "Logging your call..." message does NOT print on your screen
  310. AND no error messages print as well, then you have one or more variables
  311. set to IGNORE your call.
  312.  
  313.     This file does all it's work at LOGOFF, which is nice, because the user
  314. is not having to wait while the file writes data to the disk. All disk ops
  315. are performed once AFTER a user signs off.
  316.  
  317.     The first time you use the logger, a "Call_Log_Computers3" file will
  318. be created inside the "Call_Log1/" directory. The Call_Logger program will
  319. actually look at how you have your Computer Types set up(in BBSMENU), and
  320. will create the file to contain the EXACT computers you have set up for
  321. your unique board.
  322.  
  323.     To RESTART the Log, simply delete the file "Call_Log" from your D1
  324. variable path. The log will start anew.
  325.  
  326.     To reconfigure for new Computer types, delete the "Call_Log_Computers3"
  327. file from your "Call_Log1/" directory. An updated file will be created the
  328. first time the Call_Logger is used again.
  329.  
  330.     You should NEVER delete the file called "Call_Log_Config". Doing so will
  331. result in unknown results occurring in the log. If you happen to mistakenly
  332. delete this file, then you should also delete "Call_Log_Computers3" and the
  333. "Call_Log" file and start a fresh log.
  334.  
  335.     The text file "Call_Log" is a suitable file for use as a Readable Text
  336. File as well, so feel free to add it into your TEXTS section.
  337.  
  338. How to convert from v2.0:
  339. ~~~~~~~~~~~~~~~~~~~~~~~~~
  340.     Converting to v3.32 from v2.0 couldn't be simpler:
  341.  
  342. 1: Replace the older "Call_Logger" with the newer one in this archive.
  343.  
  344. 2: Delete the "Call_Log_Computers", "Call_Log_Config", and "Call_Log"
  345.    files from their appropriate directories. v3.32 is SO new these old
  346.    files are incompatible.
  347.  
  348. 3: Set the SysOp definable variables within the "Call_Logger" file to
  349.    fit your current needs. There are a couple NEW variables since v2.0,
  350.    so look above for more info on how they're used.
  351.  
  352.     That's all there is to it. No changes were made to the "sys.welcome"
  353. and "bbstext" lines from v2.0, so no editing of those is needed. Run the
  354. logger the same way you always have, and ENJOY!
  355.  
  356. That's It Folks!
  357. ~~~~~~~~~~~~~~~~
  358.     Well, I rewrote this _READ_ME! in hopes of making it a bit easier to
  359. understand the gobs of info I am trying to shove down your throats. PLEASE,
  360. READ THIS ENTIRE DOCUMENT TO FULLY UNDERSTAND WHAT'S GOING ON!!!
  361.  
  362.     That'll do it for this version. If you see I've made a mistake, or you
  363. think the Logger needs something else, feel free to contact me on The Metal
  364. Shoppe, or if you're a REALLY nice person, give my BBS a call for all the
  365. latest creations I've come up with.
  366.  
  367.     I run all my mods on my bbs, both those that have been released, and
  368. those that are still in BETA stages, so if you want a looksie into the
  369. future of Dotoran Files, give a call!!!
  370.  
  371.                               Dotoran's
  372.               ___  ___  ___        ____  ____  ___  ___  ___
  373.              /_   /__/ /  / /\  /   /     /   /_   /__/ /__
  374.             /    / /  /__/ /  \/   /   __/_  /__  / /  ___/
  375.  
  376.                         Bulletin Board System
  377.  
  378.                     ( 7 1 6 ) / 8 2 3 - 9 8 9 2 !
  379.  
  380.                     Now from 300 thru 28,800 baud!
  381. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  382.       Once again, the runner finds the finish line ahead of others!
  383. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  384.